home *** CD-ROM | disk | FTP | other *** search
/ Aminet 1 (Walnut Creek) / Aminet - June 1993 [Walnut Creek].iso / aminet / gfx / misc / pplot100.lha / PPlot.doc < prev    next >
Text File  |  1992-09-11  |  7KB  |  168 lines
  1. <---------------------------------------->
  2. |  PPlot Documentation for Release 1.00  |
  3. |  By Charles E. "Rick" Taylor IV        |
  4. |  September 12, 1992                    |
  5. <---------------------------------------->
  6.  
  7. Included in this archive:
  8.  
  9. PPlot             (Main program         )
  10. PPlot.doc         (This doc file        )
  11. PPlot.Support     (Required Support file)
  12. PPlot.Importing   (Another doc file     )
  13. PPtest            (A demo data file     )
  14. PPtestIFF         (A demo IFF pic       )
  15. .info files       (Icons                )
  16.  
  17. System Requirements:
  18.  
  19. The program has been tested on A500s under 1.3 and 2.04.  The program
  20. runs best under 1meg of CHIP, but it can be coaxed into running under
  21. 512K of chip.  I *do* recommend at least 1 meg of ram, though.  PPlot
  22. is very CHIP-ram intensive, so I recommend at least one meg of memory
  23. total.
  24.  
  25. The program has not been tested on the A3000 yet, so I'm not sure how
  26. well it likes/dislikes the 030.  If you have problems, please E-Mail.
  27.  
  28. Setting up:
  29.  
  30. First, make a directory for PPlot and copy all files into it.  You
  31. *need* only the PPlot and PPlot.Support files in this directory, but
  32. you may want to keep the docs around.  And there you have it ... PPlot
  33. is installed.
  34.  
  35. Using PPlot's menus:
  36.  
  37. PPlot has three main menus, the DATA MENU, the PLOT MENU, and the 
  38. SETTINGS MENU.  The program starts you off in the DATA MENU, where
  39. most of the data entry/editing functions are.  The PLOT MENU has
  40. many options for determining the plot's appearance.  The SETTINGS
  41. MENU has switches for options that can be toggled.
  42.  
  43.     DATA MENU
  44.  
  45.     New Data  : Enter a new set of data into PPlot.  Maximum 500 points.
  46.     Load      : Load an old set of data.
  47.     Save      : Save a set of data.
  48.     Quit      : Obvious.  Really. :)
  49.     Plot Menu : Go to PLOT MENU.  You must have data in memory first.
  50.     Display   : Display your data on the screen.  If you have more than 
  51.                 15 points and get a "more" prompt, just type <Return> to
  52.                 keep going, '0' to go to the beginning, and '1' to go to 
  53.                 the end.
  54.     Print     : Prints your data set and the best line to the printer.
  55.     Edit Pair : Change the contents of a point and/or the error of a point.
  56.                 You need the point number of the point you wish to change,
  57.                 obtainable with the "Display" or "Print" commands.
  58.     Add Pair  : Add another pair to your data set.
  59.     Del Pair  : Delete a pair from your data set.  Requires the point 
  60.                 number.  Asks for confirmation forst, don't worry!
  61.     Swap X&Y  : Swaps the X and Y coordinates of all the pairs.  Also 
  62.                 the error values.
  63.     X-Error   : An easy way to set the error in X on *all* your points.
  64.     Y-Error   : An easy way to set the error in Y on *all* your points.
  65.     Sort      : A "switch" to turn on/select the type of sort that will
  66.                 be performed on the data points.  Useful with the 
  67.                 Interpolate curve fit.
  68.  
  69.     PLOT MENU
  70.  
  71.     X-Bounds   : Lets you enter X boundaries for your graph.
  72.     Y-Bounds   : Lets you enter Y boundaries for your graph.
  73.     Grid/Ticks : Selects the interval at which to draw tick marks or
  74.                  grid lines.
  75.     Labels     : Title, X-axis and Y-axis labels.
  76.     Plot Data  : Plots your data using the current settings.
  77.     LSQ Fit    : Displays the equation of the Least-Squares best line.
  78.     X-Transfrm : Lets you perform several mathematical functions on
  79.                  your data (and their associated errors).  From the 
  80.                  TRANSFORM MENU, select the function to apply.  If
  81.                  there is a 'c' in the function, you wil be prompted
  82.                  for its value.
  83.     Y-Transfrm : Same as X-Transform, except for Y. :)
  84.     Settings   : Takes you to the SETTINGS MENU
  85.     Autoscale  : Sets the graph's borders and the grid/ticks to 
  86.                  something easy to display.  Use if you don't know where
  87.                  your points will fall.  Also a guide to help you set 
  88.                  bounds to get a nice looking graph
  89.     Data Menu  : Takes you back to the DATA MENU
  90.     Plot Which : Lets you select a "range" of points to plot, e.g. from
  91.                  point 15 to point 35.
  92.  
  93.     SETTINGS MENU
  94.     Plot Menu  : Guess. :)
  95.     Origin     : If possible, draw a solid set of "axes" at 0,0.
  96.     X-Bars     : Draw error bars in the X direction.
  97.     Y-Bars     : Draw error bars in the Y direction.
  98.     Line       : Draw the Least-Squares best line on the plot.
  99.     Eq'n       : Print the equation of the Least-Squares line on the graph.
  100.     Color      : Number of colors on the plot.  NOTE: Only the two-color
  101.                  plot is saveable to an IFF file.  The four-color plot is
  102.                  simply so you can look at the plot w/o being blinded by the
  103.                  flicker.
  104.     Res        : Selects the resolution of the plot (Interlace or not).
  105.     Points     : Selects the method of "marking" the location of the
  106.                  data points, e.g. putting an X at the location of the
  107.                  point.
  108.     Interp     : Selects whether to "Interpolate" the points.  This just
  109.                  does a connect-the-dots between the points.  Can look
  110.                  weird if the data isn't sorted. :)
  111.     Grid/Ticks : Selects whether to draw a grid or tick marks on the axes of
  112.                  the graph.
  113.  
  114. Using The Plot:
  115.  
  116. You have several options in the plot menu, most of them mapped to keys.
  117.  
  118.     "A"        - Autoscales the plot without changing the grid intervals.
  119.     "O"        - Sets the bounds back to what they were when you selected
  120.                  "Plot Data".
  121.     "X"        - Toggles X-Error bars.
  122.     "Y"        - Toggles Y-Error bars.
  123.     "G"        - Toggles the grid/ticks.
  124.     "4" or "6" - Sorts data in the X direction. Useful with Interpolate.
  125.     "8" or "2" - Sorts data in the Y direction. Useful with Interpolate.
  126.                  (NOTE: Look at the sides of the numeric keys. :) )
  127.     "S"        - Save the graph as an IFF file.  NOTE: Works *only* in
  128.                  Two-Color mode!
  129.     <Return>   - Goes back to the PLOT MENU
  130.  
  131. Also, you can click twice in the graph area with the mouse to zoom in on the
  132. rectangle inside where you clicked.  Sorry, no drag-select, but it's *still*
  133. useful. :) 
  134.  
  135. Usage Notes:
  136.  
  137. Any time you have a block cursor, you can use <Del> or < <- > to delete a
  138. character, or hit <Esc> to erase the entire input line.
  139.  
  140. To enter lots of points with the same error, enter the data as "exact" then 
  141. use "X-Error" and "Y-Error".
  142.  
  143. Don't set the automatic sort on when you're using long sets of data.
  144.  
  145. There is a "Quit" in the menu bar.  This quits *instantly* from any mode or
  146. any operation!
  147.  
  148. See the file "PPlot.Importing" for information on how to enter the data with
  149. a spreadsheet or another program.
  150.  
  151. Other Information:
  152.  
  153. PPlot was developed using AC/BASIC which is (C) AbSoft.  A 'C' version is 
  154. planned for sometime in the near future, when we can get around to it. :)
  155. (A Chem E student's life is a busy one... :) )
  156.  
  157. PPlot is FreEWare, which means it costs you *nothing*, but I'd like to hear
  158. from you if you have access to E-Mail and use it. :)  Questions, comments, 
  159. bug reports, whatever.  I like E-Mail. :)  PPlot is also freely distributable
  160. provided all files (except the demo pic/file) remain intact.
  161.  
  162. If Fred Fish wants to put this on a disk, he can. (Not likely, but ... :) )
  163.  
  164. ---charlet@hubcap.clemson.edu
  165.  
  166.   
  167.  
  168.